Api.Log method

Records the specified data in the logging shared memory.

Namespace: IntervalZero.KINGSTAR.Local.Api

Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0

Syntax

C#VB

public KsCommandStatus<int> Log(
       KsLogChannel[] Channels,
       int TriggerChannel,
       double TriggerValue,
       KsLogTriggerType TriggerType,
       double Duration
)

Public Function Log(
       Channels As KsLogChannel(),
       TriggerChannel As Integer,
       TriggerValue As Double,
       TriggerType As KsLogTriggerType,
       Duration As Double
) As KsCommandStatus(Of Integer)

Parameters

Channels

Type: KsLogChannel[]

The data that will be recorded in every channel.

TriggerChannel

Type: int

The channel that triggers the recording.

TriggerValue

Type: double

When the logging channel's value reaches the trigger value, the recording starts.

TriggerType

Type: KsLogTriggerType

The way to trigger the recording.

Duration

Type: double

How long you want to record the data. The unit is second. The log can be recorded up to 10 minutes. If you set it to zero, the system will continue recording and keep the latest 10-minute data.

Return value

Type: KsCommandStatus<int>

Returns a state of a method and an integer. The value (integer) stores how many cycles are logged after Log is called.

Value: total number of points to be logged.
ValueLength: four.
InSyncLatch: current log index (also the number of points already logged).

Remarks

As the logged data is stored in the shared memory, you need to use RTSharedMemory to access the logged data. The object name of the shared memory is "KSLogSpace".

Usable EtherCAT states

ecatOP

Examples

N/A